<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>MiXiM: D:/Projects/MiXiM/extsrc/mixim/src/modules/power/battery/BatteryState.h Source File</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>


</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">MiXiM
   &#160;<span id="projectnumber">2.3</span>
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5.1 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li><a href="dirs.html"><span>Directories</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('a00482.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">BatteryState.h</div>  </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- mode:c++ -*- ********************************************************</span>
<a name="l00002"></a>00002 <span class="comment"> * Energy Framework for Omnet++, version 0.9</span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> * Author:  Laura Marie Feeney</span>
<a name="l00005"></a>00005 <span class="comment"> *</span>
<a name="l00006"></a>00006 <span class="comment"> * Copyright 2009 Swedish Institute of Computer Science.</span>
<a name="l00007"></a>00007 <span class="comment"> *</span>
<a name="l00008"></a>00008 <span class="comment"> * This software is provided `as is&#39; and without any express or implied</span>
<a name="l00009"></a>00009 <span class="comment"> * warranties, including, but not limited to, the implied warranties of</span>
<a name="l00010"></a>00010 <span class="comment"> * merchantability and fitness for a particular purpose.</span>
<a name="l00011"></a>00011 <span class="comment"> *</span>
<a name="l00012"></a>00012 <span class="comment"> ***************************************************************************/</span>
<a name="l00013"></a>00013 
<a name="l00014"></a>00014 <span class="preprocessor">#ifndef BATTERYSTATE_H</span>
<a name="l00015"></a>00015 <span class="preprocessor"></span><span class="preprocessor">#define BATTERYSTATE_H</span>
<a name="l00016"></a>00016 <span class="preprocessor"></span>
<a name="l00017"></a>00017 <span class="preprocessor">#include &lt;sstream&gt;</span>
<a name="l00018"></a>00018 <span class="preprocessor">#include &lt;string&gt;</span>
<a name="l00019"></a>00019 <span class="preprocessor">#include &lt;omnetpp.h&gt;</span>
<a name="l00020"></a>00020 
<a name="l00021"></a>00021 <span class="preprocessor">#include &quot;MiXiMDefs.h&quot;</span>
<a name="l00022"></a>00022 
<a name="l00032"></a><a class="code" href="a00032.html">00032</a> <span class="keyword">class </span>MIXIM_API <a class="code" href="a00032.html" title="residual capacity of battery">BatteryState</a> : <span class="keyword">public</span> cObject
<a name="l00033"></a>00033 {
<a name="l00034"></a>00034 <span class="keyword">protected</span>:
<a name="l00036"></a><a class="code" href="a00032.html#a035f6edba77666695304d885fab6612e">00036</a>   <span class="keywordtype">double</span> <a class="code" href="a00032.html#a035f6edba77666695304d885fab6612e" title="nominal battery capacity in mW-s (mA-s at nominal voltage)">nominal</a>;
<a name="l00038"></a><a class="code" href="a00032.html#aebcd9c40f472c24575a8987dcfcf612b">00038</a>   <span class="keywordtype">double</span> <a class="code" href="a00032.html#aebcd9c40f472c24575a8987dcfcf612b" title="remaining battery capacity in mW-s">absolute</a>;
<a name="l00039"></a>00039 
<a name="l00040"></a>00040 <span class="keyword">public</span>:
<a name="l00041"></a>00041 
<a name="l00046"></a><a class="code" href="a00032.html#ae670927fcf61d4747da036db42a4a10a">00046</a>   <a class="code" href="a00032.html" title="residual capacity of battery">BatteryState</a>(<span class="keywordtype">double</span> n=-1) :
<a name="l00047"></a>00047     cObject(), nominal(n), absolute(0)
<a name="l00048"></a>00048   {}
<a name="l00049"></a>00049 
<a name="l00051"></a><a class="code" href="a00032.html#aaaacc811d07db14a871acadf438e1685">00051</a>   <span class="keywordtype">double</span> <a class="code" href="a00032.html#aaaacc811d07db14a871acadf438e1685" title="Residual capacity of battery (relative to nominal capacity).">getRel</a>()<span class="keyword"> const </span>{
<a name="l00052"></a>00052     <span class="keywordflow">return</span> absolute/nominal;
<a name="l00053"></a>00053   }
<a name="l00054"></a>00054 
<a name="l00056"></a><a class="code" href="a00032.html#a1da8df3aab646db06c6341fb48efcfe6">00056</a>   <span class="keywordtype">double</span> <a class="code" href="a00032.html#a1da8df3aab646db06c6341fb48efcfe6" title="Residual capacity of battery (in mW-s).">getAbs</a>()<span class="keyword"> const </span>{
<a name="l00057"></a>00057     <span class="keywordflow">return</span> absolute;
<a name="l00058"></a>00058   }
<a name="l00059"></a>00059 
<a name="l00061"></a><a class="code" href="a00032.html#aaa9af946d2a8a122b13d9eb16e97fc15">00061</a>   <span class="keywordtype">void</span> <span class="keyword">set</span>(<span class="keywordtype">double</span> s) {
<a name="l00062"></a>00062     absolute = s;
<a name="l00063"></a>00063   }
<a name="l00064"></a>00064 
<a name="l00066"></a><a class="code" href="a00032.html#a36ff9183e3c338cedef736514ffba096">00066</a>   std::string <a class="code" href="a00032.html#a36ff9183e3c338cedef736514ffba096" title="Returns a printable string of this battery state.">info</a>()<span class="keyword"> const </span>{
<a name="l00067"></a>00067     std::ostringstream ost;
<a name="l00068"></a>00068     ost &lt;&lt; <span class="stringliteral">&quot; battery at &quot;</span>&lt;&lt;  (absolute/nominal) * 100 &lt;&lt;<span class="stringliteral">&quot;%&quot;</span>;
<a name="l00069"></a>00069     <span class="keywordflow">return</span> ost.str();
<a name="l00070"></a>00070   }
<a name="l00071"></a>00071 };
<a name="l00072"></a>00072 
<a name="l00073"></a>00073 <span class="preprocessor">#endif</span>
</pre></div></div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><b>BatteryState.h</b>      </li>

    <li class="footer">Generated on Tue Mar 5 2013 21:26:30 for MiXiM by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
   </ul>
 </div>


</body>
</html>
